Skip to content

Fix overly broad classpath scanning in ReflectUtil.getClassesWithAnnotation()#13427

Open
vishesh92 wants to merge 1 commit into
apache:4.22from
shapeblue:fix-overly-broad-classpath-scanning
Open

Fix overly broad classpath scanning in ReflectUtil.getClassesWithAnnotation()#13427
vishesh92 wants to merge 1 commit into
apache:4.22from
shapeblue:fix-overly-broad-classpath-scanning

Conversation

@vishesh92

@vishesh92 vishesh92 commented Jun 16, 2026

Copy link
Copy Markdown
Member

Description

Production logs show a recurring WARN at startup:
"could not get type for name org.conscrypt.AllocatedBuffer"
(org.reflections.ReflectionsException / ClassNotFoundException)

Root cause: ReflectUtil.getClassesWithAnnotation() uses ClasspathHelper.forPackage() to collect URLs to scan, but this returns all classpath entries (JARs/directories), not just those containing the target package. The Reflections library then scans every .class file in every JAR — including Netty's ConscryptAlpnSslEngine$BufferAdapter which references the optional org.conscrypt.AllocatedBuffer type. During expandSuperTypes(), Reflections tries Class.forName() on that type and fails because Conscrypt is not (and need not be) on the classpath.

The fix adds a FilterBuilder that restricts bytecode scanning to only classes whose fully-qualified names match the requested packages. This prevents Reflections from processing unrelated classes (e.g., io.netty.handler.ssl.*), eliminating the warning and reducing startup time by skipping thousands of irrelevant class files.

Types of changes

  • Breaking change (fix or feature that would cause existing functionality to change)
  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Enhancement (improves an existing feature and functionality)
  • Cleanup (Code refactoring and cleanup, that may add test cases)
  • Build/CI
  • Test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

  • Major
  • Minor

Bug Severity

  • BLOCKER
  • Critical
  • Major
  • Minor
  • Trivial

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

…tation()

Production logs show a recurring WARN at startup:
  "could not get type for name org.conscrypt.AllocatedBuffer"
  (org.reflections.ReflectionsException / ClassNotFoundException)

Root cause: ReflectUtil.getClassesWithAnnotation() uses
ClasspathHelper.forPackage() to collect URLs to scan, but this
returns all classpath entries (JARs/directories), not just those
containing the target package. The Reflections library then scans
every .class file in every JAR — including Netty's
ConscryptAlpnSslEngine$BufferAdapter which references the optional
org.conscrypt.AllocatedBuffer type. During expandSuperTypes(),
Reflections tries Class.forName() on that type and fails because
Conscrypt is not (and need not be) on the classpath.

The fix adds a FilterBuilder that restricts bytecode scanning to
only classes whose fully-qualified names match the requested
packages. This prevents Reflections from processing unrelated
classes (e.g., io.netty.handler.ssl.*), eliminating the warning
and reducing startup time by skipping thousands of irrelevant
class files.

Signed-off-by: Ganesh Maharaj Mahalingam <g.mahalingam@apple.com>
@vishesh92

Copy link
Copy Markdown
Member Author

@blueorangutan package

@blueorangutan

Copy link
Copy Markdown

@vishesh92 a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

@codecov

codecov Bot commented Jun 16, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 0% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 17.67%. Comparing base (8e933b7) to head (34649c8).

Files with missing lines Patch % Lines
...ils/src/main/java/com/cloud/utils/ReflectUtil.java 0.00% 3 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff              @@
##               4.22   #13427      +/-   ##
============================================
- Coverage     17.67%   17.67%   -0.01%     
+ Complexity    15792    15788       -4     
============================================
  Files          5922     5922              
  Lines        533167   533170       +3     
  Branches      65210    65210              
============================================
- Hits          94246    94230      -16     
- Misses       428276   428291      +15     
- Partials      10645    10649       +4     
Flag Coverage Δ
uitests 3.69% <ø> (ø)
unittests 18.74% <0.00%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@blueorangutan

Copy link
Copy Markdown

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 18273

@DaanHoogland DaanHoogland left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

clgtm

@DaanHoogland

Copy link
Copy Markdown
Contributor

@blueorangutan test

@blueorangutan

Copy link
Copy Markdown

@DaanHoogland a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

@blueorangutan

Copy link
Copy Markdown

[SF] Trillian test result (tid-16355)
Environment: kvm-ol8 (x2), zone: Advanced Networking with Mgmt server ol8
Total time taken: 62791 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr13427-t16355-kvm-ol8.zip
Smoke tests completed. 141 look OK, 8 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test Result Time (s) Test File
ContextSuite context=TestExtensions>:setup Error 0.00 test_extension_custom.py
ContextSuite context=TestExtensions>:setup Error 0.00 test_extension_custom_action_lifecycle.py
test_01_create_extension Error 0.00 test_extension_lifecycle.py
test_02_create_extension_type_fail Error 0.00 test_extension_lifecycle.py
test_03_create_extension_name_fail Error 0.00 test_extension_lifecycle.py
test_04_update_extension Error 0.00 test_extension_lifecycle.py
test_05_register_unregister_extension Error 0.05 test_extension_lifecycle.py
test_06_register_extension_already_fail Error 0.05 test_extension_lifecycle.py
test_07_delete_extension_registered_resource_fail Error 0.05 test_extension_lifecycle.py
test_08_extension_sync Error 0.00 test_extension_lifecycle.py
test_09_extension_deploy_vm Error 0.05 test_extension_lifecycle.py
test_01_add_primary_storage_disabled_host Failure 117.28 test_primary_storage.py
test_create_pvlan_network Error 0.10 test_pvlan.py
ContextSuite context=TestSharedFSLifecycle>:setup Error 0.00 test_sharedfs_lifecycle.py
test_01_webhook_deliveries Error 5.26 test_webhook_delivery.py
test_01_create_webhook_admin_local Error 1.08 test_webhook_lifecycle.py
test_02_create_webhook_admin_domain Error 1.08 test_webhook_lifecycle.py
test_03_create_webhook_admin_global Error 1.11 test_webhook_lifecycle.py
test_04_create_webhook_domainadmin_local Error 5.58 test_webhook_lifecycle.py
test_05_create_webhook_domainadmin_subdomain Error 6.75 test_webhook_lifecycle.py
test_06_create_webhook_domainadmin_global_negative Error 5.63 test_webhook_lifecycle.py
test_07_create_webhook_user_local Error 5.24 test_webhook_lifecycle.py
test_08_create_webhook_user_domain Error 5.37 test_webhook_lifecycle.py
test_09_create_webhook_user_gloabl Error 5.25 test_webhook_lifecycle.py
test_10_create_webhook_admin_advanced Error 5.34 test_webhook_lifecycle.py
test_11_update_webhook Error 5.34 test_webhook_lifecycle.py
test_12_list_user_webhook_deliveries Error 5.40 test_webhook_lifecycle.py
test_13_webhook_execute_delivery Error 5.29 test_webhook_lifecycle.py

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants